Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align documentation for C:\ProgramData\Git\config #1165

Merged
merged 2 commits into from
May 18, 2017
Merged

Align documentation for C:\ProgramData\Git\config #1165

merged 2 commits into from
May 18, 2017

Conversation

asheiduk
Copy link

Fixed the confusing and inconsistent documentation for this configuration file
by

  • aligning it with the already existing upstream predecence rules
  • removing the XP-hack using ``$ALLUSERSPROFILE/Application Datainstead of$PROGRAMDATA` both in code and in docu.

Signed-off-by: Andreas Heiduk [email protected]

@YueLinHo
Copy link

/cc @csware @ch3cooli

@@ -235,8 +235,12 @@ FILES
If not set explicitly with `--file`, there are four files where
'git config' will search for configuration options:

$PROGRAMDATA/Git/config::
System-wide configuration file for *all* Git-related software running

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

$(prefix)/etc/gitconfig::
System-wide configuration file.
System-wide configuration file for this installation of Git for Windows.

This comment was marked as off-topic.

`$(prefix)/etc/gitconfig` file. Typically `$PROGRAMDATA` points to
`C:\ProgramData` (on Windows XP the equivalent in `$ALLUSERSPROFILE` is used,
i.e. `C:\Documents and Settings\All Users\Application Data\Git\config`).

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

if (!env) {
env = mingw_getenv("ALLUSERSPROFILE");
extra = "/Application Data";
}

This comment was marked as off-topic.

This comment was marked as off-topic.

@dscho
Copy link
Member

dscho commented May 15, 2017

I like the idea of this PR very much.

Please split the changes into two commits, though.

While at it, please adjust the commit messages to align with the rest of our commit messages by using the imperative instead of the past tense.

Also: the commit removing XP support should at least mention that v2.10.0 was the last Git for Windows version to support XP, and it would be really good to accompany that with a date, with a summary of the rationale (XP is EOL, but please be more verbose than that), and I guess a link to https://git-for-windows.github.io/requirements.html could not hurt.

Thanks!

Current Git for Windows supports an additional configuration location
for system setting. On contemporary versionws of Windows this is
$PROGRAMDATA/Git/config. But XP does not know about $PRORGRAMDATA so
$ALLUSERSPROFILE/Application Data/Git/config was used.

XP itself is EOL for quite some time and Git for Windows ceased to
support it officially with version 2.10.0 (release 3 Sep 2016).

https://github.com/git-for-windows/git/wiki/FAQ#which-versions-of-windows-are-supported
https://git-for-windows.github.io/requirements.html

Signed-off-by: Andreas Heiduk <[email protected]>
@asheiduk
Copy link
Author

@dscho Regarding the "extract the XP part" commit: Do you really want all the things after your "Also:" to be mentioned in the commit message?

@dscho
Copy link
Member

dscho commented May 15, 2017

Regarding the "extract the XP part" commit: Do you really want all the things after your "Also:" to be mentioned in the commit message?

I would really like all of those, yes. I am a heavy user of the git log, especially when bug hunting (which is what I spend most of my time on, and I typically have to mindshare between multiple tickets, so every bit of information that is stored in the git log helps me).

Move the description for the additional Git for Windows configuration file
into the right place, so that the following descriptions of the read priority
also covers this file correctly.

Also make it clear, what file `git config --system` selects.

Signed-off-by: Andreas Heiduk <[email protected]>
@dscho dscho merged commit 52a7159 into git-for-windows:master May 18, 2017
dscho added a commit to git-for-windows/build-extra that referenced this pull request May 18, 2017
The documentation of Git for Windows' several config files [was
improved](git-for-windows/git#1165).

Signed-off-by: Johannes Schindelin <[email protected]>
git-for-windows-ci pushed a commit that referenced this pull request May 23, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request May 23, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 29, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 29, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 29, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 30, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 30, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 30, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request May 30, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Jun 5, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Jun 7, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Jun 7, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Jun 7, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Jun 7, 2017
Align documentation for C:\ProgramData\Git\config
@dscho dscho added this to the v2.13.0(1) milestone Jun 13, 2017
dscho added a commit that referenced this pull request Jun 19, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Jun 19, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Sep 19, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Sep 20, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Sep 20, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Sep 21, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Sep 21, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Sep 26, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Sep 26, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Sep 26, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 17, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 19, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 19, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 19, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 19, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 19, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Oct 20, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Oct 20, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Oct 20, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 20, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Oct 21, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 23, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Oct 24, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Oct 30, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Nov 1, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Nov 6, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Nov 7, 2017
Align documentation for C:\ProgramData\Git\config
dscho added a commit that referenced this pull request Nov 29, 2017
Align documentation for C:\ProgramData\Git\config
git-for-windows-ci pushed a commit that referenced this pull request Dec 6, 2017
Align documentation for C:\ProgramData\Git\config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants